Sets the background for a control.

OSErr SetUpControlBackground (
    ControlRef inControl, 
    SInt16 inDepth, 
    Boolean inIsColorDevice
);

inControl

A handle to the control whose background is to be set.

inDepth

The bit depth (in pixels) of the current graphics port.

inIsColorDevice

Set to true to indicate that you are drawing on a color device; set to false for a monochrome device.

function result

A result code.

DISCUSSION

The SetUpControlBackground function allows you to set the background of a control. This function is typically called by control definition functions that are embedded in other controls. You might call SetUpControlBackground in response to an application-defined function installed in a user pane control. SetUpControlBackground ensures that the background color is always correct when calling EraseRect and EraseRgn. If your control spans multiple monitors, SetUpControlBackground should be called for each device that your control is drawing on.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)